14.2 Completar Matrícula

Atenção

É necessário existir templates cadastrados na escola para geração dos documentos de aceite digital.

Ao completar a matrícula será gerado o plano de pagamento de matrícula e também será gerado o contrato juntamente com o documento de aceite digital, somente após o aceite do documento será gerado o plano de pagamento de anuidade e a enturmação do dependente.

Em caso de contrato manual, ambos os planos são gerados e a enturmação também já acontece.

Request

Request

mutation CompleteEnrollment {
    completeEnrollment(
        data: {
            enrollmentId: 123
            enrollment: {
                academicYearId: 1
                academicSerieId: 5
                academicLevelId: 2
                academicClassId: 10
                isExempt: false
                installmentDueDate: "2025-02-10T00:00:00Z"
                totalInstallmentValue: 1200.00
                installmentQuantity: 12
                totalDiscount: 10.00
                totalDiscountIsPercentage: true
                discountLimitDate: "2025-02-05T00:00:00Z"
                useDueDateAsDiscountDate: false
                integralWithUnificationOfBillings: false
            }
            contract: {
                type: REGULAR
                financialOwnerBirthDate: "1985-05-20T00:00:00Z"
                financialOwnerRG: "12.345.678-9"
                financialOwnerOcupation: "Engenheiro"
                financialOwnerMaritalStatus: MARRIED
                relationshipDegree: "Pai"
                parentsMaritalStatus: MARRIED
                custodyArrangement: "Guarda compartilhada"
                startDateInstallment: "2025-02-10T00:00:00Z"
                totalInstallmentValue: 12000.00
                installmentQuantity: 12
                discount: 5.00
                discountIsPercentage: true
                discountLimitDate: "2025-02-05T00:00:00Z"
                useDueDateAsDiscountLimitDate: false
                withdrawalFee: 10.00
                withdrawalFeeIsPercentage: true
                sendNotification: true
                manualContract: false
                schoolEmail: "contato@escola.com.br"
                schoolWhatsApp: "11987654321"
                schoolPhone: "1134567890"
            }
        }
    ) {
        enrollmentId
        contractId
        documentId
    }
}

Params

Parâmetro	Tipo	Descrição
data	CompleteEnrollmentDataInput!	Dados para completar a matrícula

Objeto CompleteEnrollmentDataInput

Campo	Tipo	Obrigatório	Descrição
enrollmentId	Int	Não	ID interno da matrícula (Alternativa ao enrollmentRefId)
enrollmentRefId	String	Não	ID de referência da matrícula (Alternativa ao enrollmentId)
enrollment	EnrollmentDetailsDataInput!	Sim (!)	Dados acadêmicos e financeiros da matrícula
contract	ContractDetailsDataInput!	Sim (!)	Dados específicos do contrato (responsáveis, cláusulas, etc.)

Objeto EnrollmentDetailsDataInput

Campo	Tipo	Obrigatório	Descrição
academicYearId	Int!	Sim (!)	ID do ano letivo
academicSerieId	Int!	Sim (!)	ID da série
academicLevelId	Int!	Sim (!)	ID do nível acadêmico
academicClassId	Int!	Sim (!)	ID da turma
isExempt	Boolean!	Sim (!)	Isenção de matrícula
installmentDueDate	DateTime	Não	Data de vencimento da primeira parcela
totalInstallmentValue	Decimal	Não	Valor total das parcelas
installmentQuantity	Int	Não	Quantidade de parcelas
totalDiscount	Decimal	Não	Desconto total
totalDiscountIsPercentage	Boolean	Não	O desconto total é em porcentagem?
discountLimitDate	DateTime	Não	Data limite para o desconto
useDueDateAsDiscountDate	Boolean	Não	Usar vencimento da parcela como data limite para o desconto
integralWithUnificationOfBillings	Boolean	Não	Matrícula integral com unificação de boletos

Objeto ContractDetailsDataInput

Campo	Tipo	Obrigatório	Descrição
type	ContractType!	Sim (!)	Tipo do contrato
financialOwnerBirthDate	DateTime!	Sim (!)	Data de nascimento do responsável financeiro
financialOwnerRG	String!	Sim (!)	RG do responsável financeiro
financialOwnerOcupation	String!	Sim (!)	Profissão do responsável
financialOwnerMaritalStatus	MaritalStatus!	Sim (!)	Estado civil do responsável
relationshipDegree	String!	Sim (!)	Grau de parentesco com o dependente
parentsMaritalStatus	MaritalStatus!	Sim (!)	Estado civil dos pais do dependente
custodyArrangement	String	Não	Acordo de custódia
startDateInstallment	DateTime!	Sim (!)	Data de vencimento da primeira parcela (Anuidade)
totalInstallmentValue	Decimal!	Sim (!)	Valor total da anuidade
installmentQuantity	Int!	Sim (!)	Quantidade de parcelas da anuidade
discount	Decimal	Não	Desconto por pontualidade
discountIsPercentage	Boolean	Não	O desconto é em porcentagem?
discountLimitDate	DateTime	Não	Data limite para o desconto
useDueDateAsDiscountLimitDate	Boolean	Não	Usar vencimento como data limite para o desconto
withdrawalFee	Decimal	Não	Multa por desistência
withdrawalFeeIsPercentage	Boolean	Não	A multa por desistência é em porcentagem?
generateDigitalAcceptance	Boolean!	Sim (!)	Gerar documento de aceite digital
generateEnrollmentPaymentPlan	Boolean!	Sim (!)	Gerar plano de pagamentos da matrícula
sendNotification	Boolean!	Sim (!)	Enviar notificação de aceite/pagamento
manualContract	Boolean!	Sim (!)	Usar contrato manual (upload de arquivo)
manualContractFileName	String	Não	Nome do arquivo do contrato manual
manualContractFileContent	[Byte!]	Não	Conteúdo do arquivo manual (em bytes)
integralValue	Decimal	Não	Valor da anuidade integral
integralShiftContract	IntegralShift	Não	Turno do contrato integral
integralStartTime	String	Não	Início do horário integral
integralEndTime	String	Não	Fim do horário integral
includedMeals	[String!]	Não	Refeições incluídas no integral
integralWeekDays	[String!]	Não	Dias da semana do integral
integralEndDayForChanges	Int	Não	Dia do mês final para alteração integral
minimumMealsDaysPerWeek	Int	Não	Mínimo de dias por semana com refeições
minimumAbsenceDaysPerWeek	Int	Não	Mínimo de ausências para desconto
limitDayToRequestMealDiscount	Int	Não	Dia limite para solicitar desconto de refeição
schoolEmail	String	Não	E-mail da escola (para contrato)
schoolWhatsApp	String	Não	WhatsApp da escola (para contrato)
schoolPhone	String	Não	Telefone fixo da escola (para contrato)

Enum MaritalStatus

Valor	Descrição
MARRIED	Casado(a)
SEPARATED	Separado(a)
DIVORCED	Divorciado(a)
WIDOWER	Viúvo(a)
SINGLE	Solteiro(a)

Response

Campo	Tipo	Descrição
enrollmentId	Int!	ID da matrícula recém-completada
contractId	Int	ID do contrato gerado
documentId	Int	ID do documento de aceite digital gerado